Add html-noplot recipe to doc/Makefile
#1468
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
And we also tweak `make view` so that the built documentation opens regardless of whether it was built with make html or make html-noplot
in MNE-BIDS doc/conf.py we have: ``` sphinx_gallery_conf["within_subsection_order"] = "mne_bids.utils._example_sorter" ``` But AFAICT this functionality wasn't workign prior to sphinx-gallery/sphinx-gallery#1391 , which was included in the release of sphinx-agallery v0.19 (released Feb 12 2025). https://sphinx-gallery.github.io/stable/changes.html#v0-19-0 Given that v0.19 was released less than 1 year ago, I think it is reasonable to assume that devs/contributors might have a sphinx-gallery version < 0.19 installed locally, in which case building the mne-bids docuemntation will fail, but the reason/solution won't be explicit. So I think that it is best to be explicit about the minimum required sphinx-gallery version we require to be able to successfully build our docs.
scott-huberty
commented
Nov 3, 2025
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1468 +/- ##
==========================================
+ Coverage 96.90% 96.92% +0.01%
==========================================
Files 43 43
Lines 10003 10003
==========================================
+ Hits 9693 9695 +2
+ Misses 310 308 -2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Member
|
FYI it was initially copied from https://github.com/scikit-learn/scikit-learn/blob/main/doc/Makefile#L33 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In our contributing guide we say that one can do
make html-noplotto build the documentation without executing the example gallery, but thehtml-noplotrecipe doesn't actually exist!I've also put a lower pin on
sphinx-gallery, and will elaborate on that in a comment.